Stytch Android/com.stytch.sdk.consumer.passkeys/Passkeys

Passkeys

The Passkeys interface provides methods for detecting Passkeys support, registering, and authenticating with Passkeys.

Types

data class AuthenticateParameters( val activity: Activity, val domain: String, val sessionDurationMinutes: UInt = Constants.DEFAULT_SESSION_TIME_MINUTES)

Data class used for wrapping parameters used with Passkeys authentication

RegisterParameters

data class RegisterParameters(val activity: Activity, val domain: String)

Data class used for wrapping parameters used with Passkeys registration

UpdateParameters

data class UpdateParameters(val id: String, val name: String)

Data class used for wrapping parameters used with Passkeys updates

Functions

authenticate

abstract suspend fun authenticate(parameters: Passkeys.AuthenticateParameters): AuthResponse

abstract fun authenticate(parameters: Passkeys.AuthenticateParameters, callback: (AuthResponse) -> Unit)

Authenticates a Passkey registration.

abstract suspend fun register(parameters: Passkeys.RegisterParameters): WebAuthnRegisterResponse

abstract fun register(parameters: Passkeys.RegisterParameters, callback: (WebAuthnRegisterResponse) -> Unit)

Creates a new Passkey registration.

update

abstract suspend fun update(parameters: Passkeys.UpdateParameters): WebAuthnUpdateResponse

abstract fun update(parameters: Passkeys.UpdateParameters, callback: (WebAuthnUpdateResponse) -> Unit)

Updates a Passkey registration.

Properties

isSupported

abstract val isSupported: Boolean

Indicates if Passkeys is supported on the device.